Require that PR head matches that of diff when merging #303
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously, the "Manage PRs" workflow made a comment suggesting to resolve the merge conflict after any failure to merge a pull request. This comment is worded in a way that makes it somewhat applicable to other causes, but still might cause the submitter to waste time unnecessarily trying to figure out how to merge a nonexistent merge conflict when the failure had a different cause. The 405 response is not specific to a failure due to merge conflict, but I believe that all failures due to merge conflict will result in a 405. This means that the check is not perfect, but will make spurious mentions of merge conflict resolution less likely at least. A review is requested from a maintainer any time the merge fails, so they will be able to investigate and provide assistance if necessary.
Due to the limitations imposed by by using both `pull_request_target` and `issue_comment` events to trigger the "Manage PRs" workflow, the PR diff used for the validation is procured via a GitHub API request. It is necessary to check that the pull request state matches that of the diff, which is achieved via the `sha` parameter of the GitHub API request used to merge. This can not be determined from the `github` context provided by GitHub Actions to the workflow for either of the trigger events, so the pull request metadata is requested from the GitHub API at the same time as the diff. This situation requires different handling by the `merge-fail` job. Fortunately, the two failure causes result in different values from the merge request workflow step's `status` output.
per1234
added
type: enhancement
github-actions
bot
added
other
and removed
topic: code
Contributor
|
Hi @per1234. If you intended to submit a library, please check the instructions and update your pull request if necessary: |
umbynos
approved these changes
Jul 30, 2021
per1234
added
topic: code
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Due to the limitations imposed by by using both
pull_request_targetandissue_commentevents to trigger the "Manage PRs" workflow, the PR diff used for the validation is procured via a GitHub API request.It is necessary to check that the pull request state matches that of the diff, which is achieved via the
shaparameterof the GitHub API request used to merge. This can not be determined from the
githubcontext provided by GitHub Actions to the workflow for either of the trigger events, so the pull request metadata is requested from the GitHub API at the same time as the diff.This situation requires different handling by the
merge-failjob. Fortunately, the two failure causes result in different values from the merge request workflow step'sstatusoutput.Demo of updated workflow run through its paces: per1234#16 (comment)